/*
 *    Copyright 2009-2021 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package sf.database.template.mybatis;

import org.apache.ibatis.annotations.Many;
import org.apache.ibatis.annotations.One;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.UnknownTypeHandler;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The annotation that specify a mapping definition for the property.
 * @author Clinton Begin
 * @see org.apache.ibatis.annotations.Results
 * @see org.apache.ibatis.annotations.Result
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MybatisResult {
    /**
     * Returns whether id column or not.
     * @return {@code true} if id column; {@code false} if otherwise
     */
    boolean id() default false;

    /**
     * Return the column name(or column label) to map to this argument.
     * @return the column name(or column label)
     */
    String column() default "";

    /**
     * Returns the property name for applying this mapping.
     * @return the property name
     */
    String property() default "";

    /**
     * Return the java type for this argument.
     * @return the java type
     */
    Class<?> javaType() default void.class;

    /**
     * Return the jdbc type for column that map to this argument.
     * @return the jdbc type
     */
    JdbcType jdbcType() default JdbcType.UNDEFINED;

    /**
     * Returns the {@link TypeHandler} type for retrieving a column value from result set.
     * @return the {@link TypeHandler} type
     */
    Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;

    /**
     * Returns the mapping definition for single relationship.
     * @return the mapping definition for single relationship
     */
    One one() default @One;

    /**
     * Returns the mapping definition for collection relationship.
     * @return the mapping definition for collection relationship
     */
    Many many() default @Many;
}
